﻿
namespace EasyNet.Solr.Commons.Params
{
    /// <summary>
    /// Defines the request parameters used by all analysis request handlers.
    /// </summary>
    public struct AnalysisParams
    {
        /// <summary>
        /// The prefix for all parameters.
        /// </summary>
        public const string PREFIX = "analysis";

        /// <summary>
        /// Holds the query to be analyzed.
        /// </summary>
        public const string QUERY = PREFIX + ".query";

        /// <summary>
        /// Set to {@code true} to indicate that the index tokens that match query tokens should be marked as "mateched".
        /// </summary>
        public const string SHOW_MATCH = PREFIX + ".showmatch";

        /// <summary>
        /// Holds the value of the field which should be analyzed.
        /// </summary>
        public const string FIELD_NAME = PREFIX + ".fieldname";

        /// <summary>
        /// Holds a comma-separated list of field types that the analysis should be peformed for.
        /// </summary>
        public const string FIELD_TYPE = PREFIX + ".fieldtype";

        /// <summary>
        /// Hodls a comma-separated list of field named that the analysis should be performed for.
        /// </summary>
        public const string FIELD_VALUE = PREFIX + ".fieldvalue";
    }
}
